Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drop Docker config from Supervisor backup #5605

Merged
merged 3 commits into from
Feb 6, 2025
Merged

Conversation

agners
Copy link
Member

@agners agners commented Feb 5, 2025

Proposed change

The Docker config is part of the main backup metadata. It allows to setup repository specific authentication information (e.g. to use a login for Docker Hub credentials for hub.docker.com can be entered). The password for these login information gets encrypted. Because we consolidate encrypted and unencrypted backups today on Supervisor side, we end up with only one of the two metadata in the cache.

We could implement a fix by storing this particular metadata per location. However, this adds complexity and code for a feature which is not much used.

Instead, we should move to a Supervisor specific inner tar (supervisor.tar[.gz]).

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to cli pull request:
  • Link to client library pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints or add-on configuration are added/changed:

Summary by CodeRabbit

  • Refactor
    • The backup and restore processes have been streamlined to focus on essential system data. Management of Docker registry credentials during these operations has been removed, simplifying the overall workflow. This update ensures a more straightforward and reliable backup experience, with a focus on maintaining only the most critical data.

Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

Warning

Rate limit exceeded

@agners has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 6 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between bc08e27 and d3aa465.

📒 Files selected for processing (4)
  • supervisor/backups/backup.py (0 hunks)
  • supervisor/backups/const.py (0 hunks)
  • supervisor/backups/manager.py (0 hunks)
  • tests/backups/test_manager.py (1 hunks)
📝 Walkthrough

Walkthrough

The pull request removes Docker configuration handling from the backup system. Two methods related to storing and restoring Docker registry credentials have been removed from the Backup class, and associated stage calls have been eliminated from the backup and restore processes in the BackupManager. The tests have been updated accordingly by removing assertions for the removed functionality.

Changes

File(s) Change Summary
supervisor/backups/backup.py Removed store_dockerconfig and restore_dockerconfig methods from the Backup class along with references to Docker registry credentials (username, password, etc.).
supervisor/backups/manager.py Deleted calls to Docker configuration stages in methods _do_restore and _create_backup, effectively removing Docker config handling from backup and restore flows.
tests/backups/test_manager.py Removed assertions and test cases related to store_dockerconfig and restore_dockerconfig; updated error handling tests to focus on Home Assistant restoration mechanisms.

Sequence Diagram(s)

sequenceDiagram
    participant BM as BackupManager
    participant B as Backup

    BM->>B: Initiate backup creation
    Note over BM,B: Docker configuration handling removed
    B-->>BM: Return backup data
Loading
sequenceDiagram
    participant BM as BackupManager
    participant B as Backup

    BM->>B: Initiate backup restoration
    Note over BM,B: Docker configuration restoration step removed
    B-->>BM: Return restoration status
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

The Docker config is part of the main backup metadata. Because we
consolidate encrypted and unencrypted backups today, this leads to
potential bugs when restoring a backup.
@agners agners force-pushed the drop-dockerconfig-from-backup branch from bc08e27 to 0534d67 Compare February 5, 2025 13:53
Copy link
Contributor

@mdegat01 mdegat01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Two other small things we should probably remove though:

DOCKER_CONFIG = "docker_config"

DOCKER_CONFIG = "docker_config"

@agners agners merged commit d254937 into main Feb 6, 2025
20 checks passed
@agners agners deleted the drop-dockerconfig-from-backup branch February 6, 2025 10:15
@github-actions github-actions bot locked and limited conversation to collaborators Feb 8, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants